home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 5 / Gold Medal Software - Volume 5 (Gold Medal) (1995).iso / utils1 / gsr162.arj / GSR.DOC next >
Text File  |  1994-09-04  |  15KB  |  433 lines
  1.  
  2.  
  3.  
  4.                   GGGGGGGGGG      SSSSSSSSSS       RRRRRRRRR    tm
  5.                   G        G      S                R        R
  6.                   G               S                R        R
  7.                   G               S                R        R
  8.                   G               SSSSSSSSSS       RRRRRRRRR
  9.                   G      GGG               S       R     R
  10.                   G        G               S       R      R
  11.                   G        G               S       R       R
  12.                   GGGGGGGGGG      SSSSSSSSSS       R        R
  13.  
  14.  
  15.  
  16.                     Global          Search          Replace
  17.  
  18.                                  Version 1.62
  19.  
  20.                            The Programmers Scalpel!  tm
  21.  
  22.  
  23.             Copyright 1990:1994 Phil Barnett. All Rights Reserved
  24.  
  25.               GSR and all of its' associated files are Shareware.
  26.            'The Programmers Scalpel' and 'GSR' are tm Phil Barnett
  27.  
  28. GSR is Copyrighted. Please feel free to give this program to anyone who uses
  29. a DOS based computer as long as it is distributed in unmodified and complete 
  30. form.
  31.  
  32. It requires DOS 3.0 or later. It works fine with DR-DOS 6.0 and MSDOS 6.x.
  33.  
  34. You may use GSR for 2 weeks at no charge. 
  35.  
  36. Registration fee is $20.00. Please make checks payable to Phil Barnett.
  37.  
  38. This is an absolutely complete version. 
  39.  
  40.                  ****************************************
  41.                  *   Phil Barnett      (407) 884-5192   *
  42.                  *   1105 Binion                        *
  43.                  *   Apopka, Fl 32703                   *
  44.                  ****************************************
  45.  
  46. When you register this program I will mail you the latest version which will
  47. have the registration form removed from the exiting screen.
  48.  
  49.  
  50.                       INSTALLATION INSTRUCTIONS
  51.  
  52.  
  53. You may place GSR in any directory, however it is easier to use if you
  54. place it in a directory which is in the path statement of your autoexec.bat.
  55.  
  56.  
  57. GSR includes four files.
  58.  
  59. 1      GSR.EXE        The Executable Program
  60. 2      GSRAVOID.DBF   A table of special extensions (explained below)
  61. 3      GSR.DOC        This Document
  62. 4      GSR.SDA        A short description of the program.
  63.  
  64.  
  65.  
  66.              !!!!!!!!!! IMPORTANT !!!!!!!!!!! READ THIS !!!!!!!!!!
  67.  
  68.       YOU SHOULD ALWAYS MAKE A BACKUP OF THE DIRECTORY YOU ARE WORKING IN 
  69.                           BEFORE YOU BEGIN WITH GSR.
  70.  
  71.       YOU SHOULD ALWAYS MAKE A BACKUP OF THE DIRECTORY YOU ARE WORKING IN 
  72.                           BEFORE YOU BEGIN WITH GSR.
  73.  
  74.       YOU SHOULD ALWAYS MAKE A BACKUP OF THE DIRECTORY YOU ARE WORKING IN
  75.                           BEFORE YOU BEGIN WITH GSR.
  76.  
  77.    Even though every precaution has been taken to insure it's safe use, the
  78.     potential for unrecoverable change exists in any program of this kind.
  79.           GSR keeps the last 99 versions of what you are working on.
  80.  
  81.  
  82.               Of course, you should back up everything so often
  83.                     as to make this warning unnecessary!
  84.  
  85.  
  86.  !!!!!!!!!!!!!!!!!!!!!!!!! ALWAYS make a backup first !!!!!!!!!!!!!!!!!!!!!!!!!
  87.  
  88.                           Manual for GSR Version 1.62
  89.  
  90. Version 1.4 and up have Virtual file handling capabilities. This allows GSR
  91. to run in less memory, and process unlimited file size.
  92.  
  93. GSR is a Global Search and Replace program. It allows you to select a group
  94. of files to operate on. You can then specify what text to look for, and what
  95. text to replace it with. Your search can be either case sensitive or not,
  96. and you may either view each occurrence, to verify the change, or have GSR
  97. automatically make all replacements for you.
  98.  
  99. Probable uses are:
  100.  
  101. Rename an existing variable or function across many modules.
  102. Change a copyright notice.
  103. Change a client name when you are recycling code.
  104. Convert from one language version to another
  105. and many more.....
  106.  
  107. Setup options are entered into blanks after you run the program.
  108.  
  109. You may press <Esc> at any time, to stop the process. The file you are
  110. operating on at the time will remain unchanged. Files you have already
  111. confirmed changes on will remain changed.
  112.  
  113. When you see the field labeled "File Spec to Include" you should enter the
  114. type of file you wish to perform global operations on. Typical response might
  115. be;
  116.  
  117. *.C
  118. *.PRG
  119. *.BAT
  120. *.BAS
  121. *.TXT
  122. XXX*.XXX
  123. FORM??.ABC
  124. etc.
  125.  
  126. The next field you enter is 'String to Search for'. This is where
  127. you enter the text you are wishing to replace. If you need to replace text
  128. that is longer than 76 characters, or you wish to include carriage return
  129. linefeed combinations, you may use an input file instead. Place the filename
  130. in <> like this: <lookfor.txt> as the only item in the field.
  131.  
  132. (you can use any filename here, lookfor.txt is only an example)
  133.  
  134. The next field you enter is 'String to Replace with'. This is the
  135. text you wish to replace the above field with. You may also use an input file
  136. here by placing the replacement text in a file and specifying it's name
  137. in <> like this: <a:\repwith.txt> as the only item in the field.
  138.  
  139. (you can use any filename here, a:\repwith.txt is only an example)
  140.  
  141. Your next option is '(M)anual or (A)utomatic'. If you select automatic mode,
  142. the search and replace operation will complete without further intervention.
  143. If you are unsure of the consequences of this action at all, you should use
  144. manual mode instead. Manual mode will present you with each occurrence
  145. with its contextual suroundings. You can decide what to do with each 
  146. occurrence individually.
  147.  
  148. Your last option is to make GSR search for your text regardless of the case.
  149. If you choose 'Case Sensitive' = 'N', capitalization will have no bearing on
  150. your search.
  151.  
  152. pHiL will find PHIL
  153. xxxxxx will find XXXXXX
  154. PHIL will find phil
  155. copyright 1990 will find Copyright 1990
  156. etc.
  157.  
  158.  
  159. After you have set up the five primary fields, you will be presented with
  160. a summary screen of selections. This will allow you to review your setup
  161. and abort the process if you were mistaken in any way.
  162.  
  163. When you confirm your setup, the search will begin.
  164.  
  165. If you selected manual mode, each occurrence of the searched for text will be
  166. displayed in context as it is found. You will be asked:
  167.  
  168. Replace this occurrence?  (Y/N)
  169.  
  170. If you select Y, it will be replaced, and the search will continue. If you
  171. select N, the search will continue with no changes to the file.
  172.  
  173. When you have reached the end of the file, and you have previously selected to
  174. replace an occurrence, you will receive one final prompt:
  175.  
  176. Make Changes to FILENAME.EXT Permanent?  (Y/N)
  177.  
  178. If you select Y, your changes will be written. If you select N, any changes you
  179. have already selected on this file will be ignored.
  180.  
  181. In any case, if you choose to make the replacements, your original text will
  182. be renamed with the extension .GSR. Subsequent changes will increment the .GSR
  183. extension, with up to 99 changes kept on any single file name.
  184.  
  185. MYTEXT.GSR
  186. MYTEXT.GS1
  187. MYTEXT.GS2
  188. MYTEXT.GS3
  189. MYTEXT.GS4
  190. MYTEXT.GS5
  191. MYTEXT.GS6
  192. MYTEXT.GS7
  193. MYTEXT.GS8
  194. MYTEXT.GS9
  195. MYTEXT.G10
  196. MYTEXT.G11
  197. MYTEXT.G12
  198. MYTEXT.G13
  199. MYTEXT.G14
  200. MYTEXT.G15
  201.  
  202. up to 
  203.  
  204. MYTEXT.G99
  205.  
  206. 99 previous versions are kept until you choose to delete them. This is going
  207. to create a lot of backups, but is necessary due to the tremendous power of 
  208. this program.
  209.  
  210. This process repeats for every file in the selected group.
  211.  
  212. During the replacement process you are informed of your location in the group
  213. of files you are operating on. When you have finished, you are presented with
  214. statistics informing you how many replacements were made and in how many files.
  215.  
  216.  
  217. ***************************************
  218. * Command Line Reference (Batch Mode) *
  219. ***************************************
  220.  
  221. GSR /? shows the following information:
  222.  
  223. Batch Mode Specifications:
  224.  
  225. GSR /F<filespec> /L<lookfor> /R<repwith> /C<Y/N>(case sensitive)
  226.  
  227. Example:  (Parameters must be in /F /L /R [/C] order)
  228.  
  229. GSR /F*.PRG /LXXyyXX /R123123 /CY
  230.  
  231.     Replace all occurrances of XXyyXX with 123123 in *.PRG
  232.  
  233.     Case sensitive.
  234.  
  235.     Automatic replacement when found.
  236.  
  237.  
  238. Case defaults to Not Case Sensitive if not specified.
  239.  
  240. Batch Mode is always Automatic Replacement.
  241.  
  242.  
  243.  
  244. ******************
  245. * Other Features *
  246. ******************
  247.  
  248. GSR will now run in monochrome. Type GSR MONO at the command line.
  249.  
  250. You can also set a parameter in your AUTOEXEC.BAT file to force monochrome;
  251.  
  252. SET MONITOR=MONO.
  253.  
  254.  
  255.                                   GSRAVOID
  256.  
  257. Why it's here?
  258.  
  259. There are many types of files that any length text can be replaced with any
  260. other length, and never cause a problem.
  261.  
  262. There are many files, however, that allowing a change like this would cause
  263. a disaster. For this reason, I included eighteen file extensions inside GSR
  264. that cannot be written to unless the search text and the replace text are
  265. identical in length.
  266.  
  267. GSR looks for the file GSRAVOID.DBF in the current directory, and if it finds
  268. it, GSR reads in the file extensions in GSRAVOID instead of using it's 
  269. internal list.
  270.  
  271.   This means: If you need to override the default values, you need to modify
  272.               GSRAVOID.DBF and put it in the directory where you are working.
  273.  
  274. This allows you to add to or override my eighteen extensions.
  275.  
  276. The extensions I avoid internally are:
  277.  
  278. .COM       .EXE       .DBF       .DBT       .NTX       .NDX       .PAK
  279. .OVL       .LIB       .OBJ       .MEM       .SYS       .ZIP       .ARC
  280. .IDX       .MDX       .DBV       .LZH
  281.  
  282. Changing the length of any of these types of files would spell certain 
  283. disaster. You may add more if you wish by filling in more records in
  284. GSRAVOID.DBF with any dBASE type program. You do NOT need to put GSRAVOID.DBF
  285. in a directory for GSR to work. It only exists so you can override my defaults.
  286.  
  287.  
  288.  
  289. WARNING!
  290.  
  291. DISCLAIMER:
  292.  
  293. You are totally responsible for the use of this program. If it causes damage
  294. of any kind, you are responsible. In no way will I, Phil Barnett, assume any
  295. expense or provide any compensation for the use or misuse of this program.
  296.  
  297. YOU SHOULD ALWAYS MAKE A BACKUP OF THE DIRECTORY YOU ARE WORKING IN
  298. BEFORE YOU BEGIN WITH GSR. 
  299.  
  300. GSR is a tool, nothing more. It can be used in a beneficial way as easily as
  301. a damaging way. I hope you find it of benefit to you. I wished for a program
  302. like this for a long time, and after giving up hope of finding it, I finally
  303. wrote it myself. I use it constantly, and wish I'd had it years ago. 
  304.  
  305. Good Luck, Good Programming, and God Bless You.
  306.  
  307. My motto:    Easier is Better!
  308.  
  309.  
  310.  
  311. MODIFICATONS HISTORY (minor increments indicate that only minor portions
  312.                       of the code were modified or debugged)
  313.                       
  314. Version 1.62 GSR now sets the DOS errorlevel on exit, to indicate how 
  315.              many occurrances were replaced. This may be important in 
  316.              command line usage and batch files.
  317.  
  318.              Compiled in Clipper 5.2d.
  319.  
  320. Version 1.61 Removed my debugging message (oops!) that prevented GSR 
  321.              from running in batch mode without user intervention. 
  322.              
  323.              Compiled in Clipper 5.2c.
  324.  
  325. Version 1.60 Rewrote file traversal algorithm.
  326.  
  327.              Rewrote search and replace algorithm.
  328.  
  329.              Switched to Clipper 5.2.
  330.  
  331.              Added functions from Clipper Tools III library.
  332.  
  333.              Dropped all functions from FUNCky library.
  334.              
  335.              Dropped workaround from version 1.56.
  336.              
  337. Version 1.57 Batch mode left colors in changed state.
  338.  
  339.              Improved Batch Mode to allow spaces in Search and Replace 
  340.              data.
  341.                       
  342. Version 1.56 Repaired obscure midfile bug. This appears to be from a bug 
  343.              in the Clipper language itself. A workaround eliminates the 
  344.              problem.
  345.                       
  346. Version 1.55 Repaired obscure missing trailing bytes bug.
  347.              
  348.              New colors on VGA monitors.
  349.  
  350.              Allowed filespec, lookfor and repwith variables to
  351.              remain after each loop.
  352.              
  353.              This version has a Batch Mode interface.
  354.              
  355.              Automatic snow removal on all CGA monitors.
  356.  
  357. Version 1.54 Further speed enhancements.
  358.              
  359.              Improved Color scheme.
  360.              
  361.              Exploding Boxes.
  362.              
  363.              Shadows by the Hour. 
  364.              Shadows around boxes act like the hour hand on a clock.
  365.  
  366. Version 1.53 Erase $temp.$$$ on exit from program.(just to make sure)
  367.  
  368.              On unregistered version, GSR now checks to see if your
  369.              printer is ready before printing the registration form.
  370.              
  371.              Save original DOS screen and restore it on termination of
  372.              program.
  373.  
  374. Version 1.52 fixed bug in GSR that ocassionally caused output text to 
  375.              have sections of it changed to upper case. 
  376.  
  377. Version 1.51 loops back to the main menu and retains last file spec.
  378.  
  379.              Cleaned up the code a little for better performance.
  380.  
  381. Version 1.5 removed .BAT from avoidance list.
  382.  
  383.             Allowed users to remove snow from older CGA displays.
  384.  
  385.             Stays in program until user requests end of program.
  386.  
  387. Version 1.4 update added a virtual file manager, making it possible to use GSR
  388.             on ANY size of file. This was a total rewrite.
  389.  
  390.             1.4 no longer copies the original file to the backup name.
  391.             The original file is now RENAMED to the backup name.
  392.             
  393.             added monochrome switch on the command line:
  394.             GSR MONO for monochrome operation on Mono-VGA's
  395.  
  396. Version 1.3 is the first Shareware version.
  397.  
  398.             added ability to specify 'use files' on disk to fill the search
  399.             and replace parameters.
  400.             
  401.             added case sensitivity.
  402.  
  403. Version 1.2 was the Gamma version
  404.  
  405.             added the c routine that allows rapid context viewing allowing
  406.             the new user interface to emulate the Norton Text Search (TS.EXE)
  407.             look and feel. 
  408.             
  409.             added manual refusal on changes.
  410.  
  411. Version 1.1 was the Beta version.
  412.  
  413. Version 1.0 was my original creation, a diamond in the rough. 
  414.  
  415.  
  416. CREDITS:
  417.  
  418. Thanks to the generosity of Rusty Justin for making this creation necessary.
  419. (I mean it. Thanks, Rusty!)
  420.  
  421. Nortons Text Search (TS.EXE) is a copyrighted and trademarked program by 
  422. Peter Norton Computing.
  423.  
  424. I must admit, that I always wished and waited for Peter Norton to upgrade his
  425. TS.EXE program to do what GSR.EXE does. When Peter Norton Computing was 
  426. purchased by another company (Symantec), the 5.0 version was released. TS.EXE
  427. was no longer offered as a utility in the 5.0 Advanced Version. By this time,
  428. I knew I would never see Peter Norton Computing create the program I had wished
  429. for. I proceeded to create it.
  430.  
  431. (further notes: As of Nortons' Version 6.0, TS.EXE was reinstated as a greatly
  432. improved program. Still no replace function....)
  433.